home *** CD-ROM | disk | FTP | other *** search
/ MacWorld 1998 March / Macworld (1998-03) (Disk 1).dmg / Shareware World / Info / For Developers / FatObjectPlant1.4.3 / Object Plant README 1.4.3 < prev    next >
Text File  |  1997-10-31  |  26KB  |  463 lines
  1. The Object Plant 1.4.3
  2.  
  3. Date of Release: 31 October 1997
  4.  
  5. The Object Plant is a OOA/OOD tool based on the OMT notation. It can be used to create
  6. Object Models, State Diagrams, Event Trace Diagrams and finally it can generate C++
  7. code skeletons.
  8.  
  9. The Object Plant folder contents:
  10. - Object Plant README 1.4.3    this file
  11. - Object Plant                          PowerPC version of the program
  12. - 68k Object Plant                   68k version of the program
  13. - C++ Data Types                      text file with a subset of the standard C++ types
  14. - C++Template.cc                     template file for generation of C++ code skeletons
  15. - C++Template.h                       template file for generation of C++ code skeletons
  16. - Class.java                             template file for generation of Java code skeletons
  17. - Interface.java                       template file for generation of Java code skeletons
  18. - HTML Class template             template file for generation of class HTML
  19.                                                 documentation
  20. - HTML Interface template       template file for generation of interface HTML
  21.                                                 documentation
  22. - User's manual                        the user's manual in pdf (Acrobat) format
  23. - Example (Object Plant)         an example document
  24. - Register                                program for creating register forms to be sent to Kagi 
  25.  
  26. Requirements:
  27. System 7.1 or later
  28. 68020 or better
  29. 2 Mb free RAM
  30.  
  31. Registering
  32. To register use the Register program to create a register form which then shall be sent
  33. to Kagi Shareware using mail, email or fax.
  34.  
  35. The price for a single license is 25 USD, there are also site and world licenses available for
  36. 500 USD resp. 2000 USD.
  37.  
  38. http://www.kagi.com
  39. Email: shareware@kagi.com        (1 to 3 day processing time delay)
  40. FAX: +1 510 652 6589            (4 to 8 day processing time delay)
  41. Postal address:                       (4 to 8 day delay plus transit time to Kagi)
  42. Kagi
  43. 1442-A Walnut Street #392-MU
  44. Berkeley, California, 94709-1405
  45. USA
  46.  
  47. Please note that Kagi automatically rejects any electronic payment that come includes
  48. a hotmail.com address. Refer to http://www.kagi.com/FAQs/hotmail.com
  49.  
  50. N.B. Kagi is a payment processing company and they are not the author/shipper of the
  51. product. Any problems with receiving registration codes or any problems with the product itself shall be addressed to the author at m-arc@algonet.se or micke@kagi.com
  52.  
  53. Registration codes will be sent to you normally within a week after receive a
  54. confirmation of your order from Kagi.
  55.  
  56.  
  57. Disclaimer
  58. This software is provided "as-is". I take no responsiblity in any damage caused by the
  59. software, use of the software or any of its outputs such as generated code. Use it at
  60. your own risk.
  61.  
  62. Changes in 1.4.3 (31 October 1997)
  63. • Added several new tags that can be used in the code generation templates:
  64.    TIMESTAMP, DATESTAMP, DATETIMESTAMP, PROGRAMMER, DATECREATED, DATEMODIFIED
  65. • The creator type of generated files will now be the same as the template files'.
  66. • Fixed a bug that crashed Object Plant when changing the name to a longer package name.
  67. • Added possibility to indicate navigability of associations and aggregations.
  68.    The navigability arrows will only be shown when UML notation is used.
  69. • Moved the "Suppress page name in reference items"-option from the preference dialog
  70.    to the the View menu.
  71. • Added more keyboard shortcuts:
  72.    command-option-left arrow: align left
  73.    command-option-right arrow: align right
  74.    command-option-top arrow: align top
  75.    command-option-bottom arrow: align bottom
  76.    command-option-A: select association tool
  77.    command-option-C: select class tool
  78.    command-option-G: select generalization tool
  79.    command-option-H: select aggregation (has a) tool
  80.    command-option-I: select interface tool
  81. • Corrected a couple of EPS bugs.
  82. • Added undo for delete of items in diagrams.
  83. • And much more...
  84.  
  85.  
  86. Known Bugs
  87.  
  88. • The main windows sometimes look "messy". Everything is not erased properly when
  89.    moving parts around.
  90. • Illustrator has some problems parsing exported pictures (PICT format). All
  91.    textstrings are drawn in a white colour, hence they are invisible.
  92. • The names of generalizations, aggregations and associations are never displayed. 
  93. • Moving a set of relationsships and classes can sometimes leave some of the lines
  94.    behind. 
  95. • If you use code generation, you cannot use the ':' character in class names.
  96. • Line drawing is not very good. When changing between different views lines are not
  97.    updated (adjusted) as expected.
  98. • If the "Page Setup" or "Print Page" commands do not work, try selecting a printer in
  99.    the chooser.
  100. • Snap to grid is only implemented in the Use Case diagram page.
  101. • Packages cannot be copied.
  102. • Manual not completely updated for 1.4.3.
  103. • EPS output for free text may not be correct. I have no possibility to verify this.
  104.  
  105. Use the web-page http://www.softsys.se/ObjectPlant/ to get new releases, report bugs etc. 
  106.  
  107. Questions concerning the program can be sent directly to the author at m-arc@algonet.se or
  108. micke@kagi.com
  109.  
  110.  
  111. This program should only travel in the complete folder.
  112.  
  113. Have fun,
  114.  
  115.                 Mikael Arctaedius
  116.         Stockholm, Sweden
  117.  
  118.         email: m-arc@algonet.se
  119.         http://www.softsys.se/ObjectPlant/
  120.  
  121.  
  122. Release History
  123.  
  124. Changes in 1.4.2 (22 September 1997)
  125. • Added two new tools: text and frame tool. Text tool can be used to insert any free
  126.    text string in a diagram. Frame tool can be used to visually group items.
  127. • Reference items can not be copied any more. This is necessary to avoid dangling
  128.    pointers (if the original item is deleted when the clipboard contains a reference).
  129. • Names of reference items shall now be correct in association dialogs.
  130. • Dragging "collapsed" windows will now track the mouse correct.
  131. • Using forward delete in the operation dialog when a parameter is selected
  132.    will no longer insert a delete character in the text edit field.
  133. • New C++ templates which makes it possible to add initializations in constructors.
  134. • Corrected quite a few bugs in the code generation. Regeneration of code shall be safer
  135.    now.
  136.  
  137. Changes in 1.4.1 (31 Augusti 1997)
  138. • Sorting of classnames in popupmenu when creating a class reference.
  139. • New Java templates
  140. • Better redraw in event trace diagrams (thread names)
  141. • Delete of package in State Diagrams and Event Trace diagrams will now delete
  142.    the associated page as well as the package item.
  143. • New line drawing algorithm in State Diagrams.
  144. • Align in Use Case and State diagrams will now work as expected.
  145. • Closing the page palette will now be the same as closing the document. This is
  146.    the start of a slow migration to make the main windows close with File->Close and
  147.    close the document can only be done by closing the page palette and a special menu
  148.    command, e.g. Close project.
  149. • Better cursor handling (no more flickering cursors).
  150. • You can now choose to generate code for all classes (and interfaces) or only
  151.    selected classes.
  152. • Better scroll behaviour in the main windows.
  153. • Sorting of interface names in popupmenus.
  154. • Fixed a drawing bug related to associations.
  155. • Added a class browser palette. It lists all classes in alphabetical order (sorted
  156.    only on the first four characters). It can be used to bring up a class info dialog by
  157.    doubleclicking the class name and if you select a class in the class browser you
  158.    can drag and drop on the Object Model window to create a reference to that class.
  159. • All the major disclosure triangles saves their state when the document is open.
  160.    When you close the window and later reopens it, the triangles will remember their
  161.    previous state. The state is not saved to the file, why all disclosure triangles are closed
  162.    when opening a document.
  163. • All the major dialog info windows saves the position and size when the document
  164.    is open. This means that the next time you bring up an info window it will be positioned
  165.    where you last closed it, and it will have the same size. The position and size is not
  166.    saved to the file, why the position and size will be the default one when opening an
  167.    info window for the first time.
  168. • Made it possible to open files with packages in Event Trace diagrams and State diagrams.
  169. • And much more...
  170.  
  171. Changes in 1.4 (10 Augusti 1997)
  172. • Corrected some problems with "Export Page...". When "Best fit" is selected a best fit
  173.    will actually be done when exporting in EPS format. This was not true in previous
  174.    releases.
  175. • Class names are sorted in popup-menus. Not a complete sorting but only on the first 4
  176.    characters (to make it fast).
  177. • Screen update problems when opening and closing description box for operations has
  178.    been fixed.
  179. • Added package tool in all diagrams.
  180. • I have tried to make it easier to grab line selection boxes.
  181. • UML generalization arrows are now prettier.
  182. • Removed ... from New in file menu.
  183. • Added possibility to declare a operation/attribute final. This is useful when
  184.    generating Java code. New Java templates will be released later.
  185. • Added possibility to declare an initial value for attributes. Useful for Java.
  186. • Corrected bug related to copying of static methods. Now the static flag is copied
  187.    correctly.
  188. • Corrected a bug that made the Copy command only copy the visible area of a window,
  189.    not all selected items.
  190. • Corrected a crash bug related to Notes.
  191. • Corrected a crash bug related to deleting items in Event Trace diagrams.
  192. • Larger selection area for threads.
  193. • No drag-and-drop if the system doesn't support it. Should make it possible to run
  194.    under 7.1 again.
  195. • Corrected screen update problem when editing the class name in the main window.
  196. • When editing an item's name in a main window (by clicking on the name and the name
  197.    turns into a editable textfield), the textfield will now revert to non-editable when
  198.    hitting the return key.
  199. • Correctly quite a few crash bugs. Earlier versions of the program left items in the
  200.    model even if you deleted them. These "dangling" items were often the cause of
  201.    crashes.
  202. • Corrected a problem related to copy&paste. If you had copied an operation (or
  203.    attribute) and then tried to copy&paste a text in a class info window, the text
  204.    didn't get copied but only the last copied operation.
  205. • The grow icon in the right lower corner was missing in the Page info window when
  206.    the window was resized. This has now been fixed.
  207. • When opening a document with windows larger than the current screen, the windows
  208.    are automatically resized to fit the current screen.
  209. • Added consistency checks that are run when opening a document. They are fast and
  210.    shall not be noticable to the user but adds a great deal of security. Should reduce
  211.    the possibility of crashing when deleting items, or when closing a document.
  212. • This version includes traceback symbols to give better logs if (when?) crashing.
  213. • Deleting an operation no longer causes a crash.
  214. • Deleting a class with references on other pages no longer causes a crash.
  215. • Fixed a crash bug related to classes with associations.
  216. • Fixed a bug that made some attributes invisible when drag-and-drop a new attribute.
  217.    (Same goes for operations.)
  218. • Exported pictures shall no longer contain "selection handles".
  219. • Better scrollbar handling.
  220. • Made the Copy Protection scheme "smarter". Even if Object Plant crashes you should
  221.    be able to restart it on the same machine without getting that annoying "...another
  222.    copy with the same registration number..." message. Perhaps it is a bit too "smart".
  223. • The description field in page info windows will now be resized if you resize the
  224.    dialog window.
  225. • The popup menu in the state page info window will now be redrawn when you change
  226.    the window size.
  227. • You can add and delete parameters in the operation dialog window. Although the Add
  228.    Parameter menu item isn't active (I haven't figured out to get it active in a modal
  229.    dialog) the shortcut (shift-command-P) is active and can be used to add a parameter.
  230.    To delete a parameter select the parameter by clicking on the parameter and the 
  231.    press either delete or backspace.
  232. • Restructured the preferences dialog and moved it to the Edit menu.
  233. • Names can be edited without bringing up a dialog window. This goes for class names, 
  234.    interface names, state names, event trace thread names, use case names, package
  235.    names, and actor names. Just click on the name, hold the mouse still and it changes
  236.    into an editable text field. Clicking somewhere outside the name, changes the
  237.    textfield back to non-editable.
  238. • If the "Open info window on create" option is disabled, the editable text field will be
  239.    enabled immediately when creating an item.
  240. • Added a "Synchronized" flag for operations.
  241. • Added an "Abstract" flag for operations (which is only enabled when the class is
  242.    abstract and makes it possible to generate code for both virtual and pure virtual
  243.    functions).
  244. • The align dialog remembers its settings and position on screen.
  245. • New set of icons. You may need to rebuild your desktop to see the new icons.
  246. • Added the option to select which Object Model pages that should generate code.
  247.    Doubleclick on the page's name in the page palette and you will find a checkbox in
  248.    dialog window which can be checked for pages that shall generate code. Pages that
  249.    generate code are marked with an asterisk at the right end of the page palette list.
  250. • Removed the "Other..." item in popup menus. Now there is a textfield which can be
  251.    used to enter types not available in the popupmenu. This is more in line with
  252.    Apple HIG.
  253. • Corrected a bug that made operations and attributes disappear if
  254.    dragged-and-dropped onto themselves.
  255. • Added feedback indication where drag-and-dropped items are being dragged to.
  256. • Corrected some bugs related to closing of a document (after it has been saved). These
  257.    bugs caused crashes occasionally.
  258. • Corrected a bug related to selection in dialog windows. Previously it was possible to
  259.    have an operation selected as well as a text area. If you tried to copy the text
  260.    (Edit->Copy) you would get the operation instead of the text. Now only one selection
  261.    shall be active at any time.
  262. • Added Use Case diagrams.
  263. • New line drawing algorithms in the Use Case window. You can select if you want a
  264.    line to always stay rectilinear or if shall be oblique. Furthermore the "snap-to-grid"
  265.    option is implemented in the Use Case diagram.
  266. • Fixed a crash bug related to notes in the Event Trace window.
  267. • And a lot more...
  268.  
  269. Changes in 1.3.4 (1 May 1997)
  270. • Corrected a bug that could corrupt the object model (or state model) when using
  271.    several pages.
  272. • Pressing TAB in a dialog window (i.e. a class dialog window) will move the
  273.    text-cursor to the next textfield but now also select that text.
  274. • Added copy of PICT to the clipboard (consider this to be a beta version) making it
  275.    possible to easy insert graphics into other documents.
  276. • If there are unterminated strings in a template file, Object Plant will give you a
  277.    syntax error warning and not crash into MacsBug (or the Finder if you don't have
  278.    MacsBug).
  279. • Corrected a bug that could make Object Plant crash if generating code when the first
  280.    page had no real classes only subsystems. If it didn't crash, it didn't either generate
  281.    any code for the classes in the subsystems.
  282. • Corrected some bugs related to generalizations. It wasn't possible to make a
  283.    multibranch generalization between interfaces. And Object Plant could crash if you
  284.    tried to make a branch from a interface generalization to a class.
  285. • Added a consistency check that is run whenever you open a file. It will only detect
  286.    some of the possible consistency errors. If any errors are found, they can be fixed by
  287.    Object Plant.
  288. • Corrected a bug that made it impossible to resize an event trace box when
  289.    interactions were connected to the very top of the box.
  290. • Removed calls to AddResource when creating popup menus. This will make it possible
  291.    to run a locked copied of Object Plant, e.g. from a CD. It will also reduce the
  292.    possibility of running into problems when creating lots of popup menus.
  293. • Opening a file with very large windows on a small screen will automatically resize
  294.    the windows to fit within the screen (in a single monitor configuration).
  295. • Corrected minor UI bugs.
  296.  
  297. Changes in 1.3.3 (19 April 1997)
  298. • Change the way File->Save and Save As operations are implemented. Now the
  299.    implementation is in line with what Inside Macintosh recommends. This includes
  300.    using a temporary file during save and when the save is completed, the temporary
  301.    file and the project file is replaced. This make it less possible that Object Plant will
  302.    corrupt project files if crashing during save.
  303. • Removed a CDEF that was incompatible with MacOS 8.0a.
  304.  
  305. Changes in 1.3.2 (1 April 1997)
  306. • Corrected a bug that occured when deleting pages. Both Object Model pages and State
  307.    Diagram pages were affected by this bug. The crash occured when trying to save a
  308.    document with a deleted page.
  309.  
  310. Changes in 1.3.1 (21 March 1997)
  311. • Corrected the bug that caused a crash when adding new data types in the
  312.    File->Document Info->Data Types dialog.
  313. • Corrected some bugs related to the copy function. Copying some parts of a state
  314.    diagram or an event trace diagram, caused a user break into Macsbug.
  315.  
  316. Changes in 1.3 (28 Feb 1997)
  317. • Started implementation of the Unified Modeling Language notation. You can set the
  318.    notation used for a document in the File->Document Info->General dialog. The default
  319.    is OMT.
  320. • Reference items (class or interface) are now displayed with its name as "page::class
  321.    name"' where page indicates which page the original item belongs to. This makes it
  322.    is easier to see which items that are references and also to locate the original item.
  323. • Better code generation. Less empty lines. Tabs handled better etc. Please note that if
  324.    you have your own customized code generation template files they maybe have to be
  325.    modified. Any '"' (quote) characters must be included into a string. A string is
  326.    enclosed by "" (quotes). Within a string special characters like '\t', '"', '\\' may be
  327.    used, just like a C-string.
  328. • Added Input/Output information to operation parameters. This may be used to
  329.    generate CORBA IDL code.
  330. • Extended the code generation template language. Some of the new tags will not work 
  331.    correctly on old files. This applies to the following tags {CONSISTOFLIST},
  332.    {PARTOFLIST}  and {ASSOCLIST}. These tags are used in the HTML template file.
  333. • Added the '$' character in front of static operations and attributes in the Object
  334.    Model.
  335. • Made it possible for interfaces to inherit each other.
  336. • Made it possible to have an association between a class and an interface.
  337. • Added more template files: Java code generation and HTML documentation.
  338. • Added an example project file.
  339. • Corrected some UI glitches in the class dialog window.
  340. • Corrected the bug that made operations and attributes created after a drag-and-drop
  341.    disappear.
  342. • Drag-and-drop operations now mark the file as dirty.
  343. • The static-field of an attribute is now correctly copied when using copy-paste.
  344. • Corrected a bug that made Object Plant crash if you closed all three main windows,
  345.    accepted to close the document and then did cancel the save operation.
  346. • Corrected a bug that made Object Plant crash if altering a document that was
  347.    previously saved with any other page selected that the very first in either the Object
  348.    Model or the State Diagram.
  349. • Better region handling makes it easier to draw branches from generalization
  350.    "triangles" and aggregation "diamonds".
  351. • A non-registered program can create max 20 classes and max 20 interfaces.
  352. • Added a shortcut button in the "Other datatype" dialog which you can use to
  353.    immediately add a new datatype to the document's list of data types.
  354. • And much more...
  355.  
  356. Changes in 1.2.4 (6 Feb 1997)
  357. • Deleting a reference item such as a class reference corrupted the object model.
  358.    Having a corrupt object model could either cause a crash at opening, saving or closing
  359.    the document. This bug is fixed in 1.2.4.
  360.  
  361. Changes in 1.2.3 (4 Feb 1997)
  362. • When creating an association it was not always drawn. This occured when the two
  363.    classes were "misaligned" forcing the association to use two right-angled lines.
  364.    Having an association with no lines could cause crashes when saving or opening the
  365.    document or even moving one of the two classes.
  366. • The qualifier box of the "client" side of an association was not moved if that endpoint
  367.    of the association was moved.
  368.  
  369. Changes in 1.2.2 (15 Jan 1997)
  370. • Corrected a bug that made it impossible to make reference classes (and interfaces)
  371.    refering to classes (interfaces) located on other pages than the very first Object
  372.    Model page.
  373. • Corrected a bug that sometimes caused Object Plant to crash when closing a
  374.    document.
  375. • Added EPS support for suppliers.
  376. • Corrected a bug that made it impossible to use the knife tool on supplier lines.
  377. • Corrected a bug that made oblique dashed lines take the wrong path.
  378. • Tried to fix some problems with generalization line drawing.
  379. • Tried to fix some problems with selecting lines.
  380.  
  381. Changes in 1.2.1 (7 Jan 1997)
  382. • The Interface dialog window is now properly updated when clicking any of the
  383.    disclosure triangles.
  384. • Generating code for classes or interfaces with no operation will now work.
  385. • You can now open documents with one or several of the three main windows closed.
  386.    This caused a crash in the 1.2 version.
  387. • Perhaps the Copy Protection is more "tolerant". Now I hope it will be possible to
  388.    restart Object Plant if it crashes without having to reboot the mac.
  389.  
  390. Changes in 1.2 (31 Dec 1996)
  391. • Made it possible to select more than one attribute (or operation) in the class info
  392.    dialog using shift selection.
  393. • Added possibility to have several "icons" refering to one single class. This can be
  394.    useful when a class needs to be included in several pages. E.g. if you have a common
  395.    base class called CObject which all other classes inherits, you create the CObject
  396.    class in one page and in the other pages you use a reference class refering to the
  397.    CObject class. (Refer to the User's Manual for details.)
  398. • The above goes for interfaces too.
  399. • Added truncation of filenames so that code generation for classes with long names
  400.    works.
  401. • Removed MacsBug user breaks that occured when generating code.
  402. • Corrected a code generation bug that occured when a class had a name identical to
  403.    the name of an Object Model page. Now created folders have a ƒ letter at the end of
  404.    the name  thus reducing the possibility for this to occur. (Change in code generation
  405.    template files.)
  406. • Made it possible to add parameters to interface operations.
  407. • Added drag-and-drop to class, interface and state info windows. This can be used to
  408.    re-order attributes, operations within a class/interface or events within a state.
  409. • Corrected the bug that caused an error alert show up saying "Serious Error. Please
  410.    Report. ... ClassType: <some large number>". This happened if you opened a file by
  411.    dropping it onto Object Plant or by doubleclicking on the file.
  412. • Zooming of windows is now implemented according to Inside Macintosh. Hence
  413.    multiple screens will be handled in correct way.
  414. • Corrected at least one of the bugs that caused a crash at startup of Object Plant.
  415. • Better handling of multiple screens in the sense that if you save an Object Plant file
  416.    where you have the windows distributed over several screens and then open the file
  417.    when only one screen is available, the windows' positions are adjusted so that all
  418.    windows are visible on the available screen(s).
  419. • Data types are now case sensitive.
  420. • Some internal cleanup making Object Plant easier to maintain.
  421. • The delete key can now be used to delete selected items in the Class info dialog. If no
  422.    item (such as an attribute or operation) is selected the delete key is applied to the
  423.    active text field. This change is valid also for the Interface info window and State
  424.    info window.
  425. • Class and interface names are now written in a bold font.
  426.  
  427. Changes in 1.1.1 (4 Dec 1996)
  428. • Corrected the bug that made class descriptions not to be stored.
  429. • Made it compatible with extensions like Stretch and Church Window WDEFs.
  430. • Corrected a bug that made updates in the Class info window not work as expected.
  431. • Corrected the bug that prevented text inside notes from being printed.
  432. • Corrected a bug that made Object Plant sometimes crash when clicking in the
  433.    attributes or operations disclosure triangle.
  434. • Added FlushVol calls to make Save and Save As operations more secure.
  435. • Corrected a bug that sometimes amde Object Plant crash when deleting a class.
  436.  
  437. Changes in 1.1 (6 Nov 1996)
  438. • The generalization triangle is now directed towards the superclass regardless of the
  439.    physical position of the superclass and subclass.
  440. • Made the SUBSYSTEM tag valid in top-level and class-level in the template language.
  441. • Corrected the bug that made Object Plant crash when trying to copy an association.
  442. • Corrected the bug that made Object Plant stop with a warning popup (or break into
  443.    Macsbug) saying "Cannot create popupmenu".
  444. • Full implementation shift-clicking. If you shift-click on an already selected object it
  445.    will be deselected.
  446. • Corrected the bug that caused Object Plant not to generate code for classes below a
  447.    subsystem which did only contain subsystems and no real classes.
  448. • Lists will now show up correctly even when using monitors supporting thousands of
  449.    colours. Previously these lists were all black.
  450. • Added two new items to the Object Model diagrams: Interfaces and supplier relations.
  451. • Changed the code generation template language so that generating code with multiple
  452.    inheritance is possible.
  453. • Added "static" checkbox to attributes and operations. Affects only code generation.
  454. • Better screen updates.
  455. • Corrected other minor bugs.
  456.  
  457.  
  458. Changes in 1.0 (9 Oct 1996)
  459. • Made line movements more smooth. Straight lines are kept straight whenever
  460.    possible.
  461. • Added a DESCRIPTION tag to be used in code generation.
  462. • Corrected minor bugs.
  463.